home *** CD-ROM | disk | FTP | other *** search
/ MacHack 1997 / MacHack 1997.toast / Hacks / Hacks ’96 / VideoFolder 1.0a / Source / MoreFiles 1.4.1 / MoreFilesExtras.h < prev    next >
Text File  |  1995-12-21  |  63KB  |  1,730 lines
  1. /*
  2. **    Apple Macintosh Developer Technical Support
  3. **
  4. **    A collection of useful high-level File Manager routines.
  5. **
  6. **    by Jim Luther, Apple Developer Technical Support Emeritus
  7. **
  8. **    File:        MoreFilesExtras.h
  9. **
  10. **    Copyright © 1992-1995 Apple Computer, Inc.
  11. **    All rights reserved.
  12. **
  13. **    You may incorporate this sample code into your applications without
  14. **    restriction, though the sample code has been provided "AS IS" and the
  15. **    responsibility for its operation is 100% yours.  However, what you are
  16. **    not permitted to do is to redistribute the source as "DSC Sample Code"
  17. **    after having made changes. If you're going to re-distribute the source,
  18. **    we require that you make it clear in the source that the code was
  19. **    descended from Apple Sample Code, but that you've made changes.
  20. */
  21.  
  22. #ifndef __MOREFILESEXTRAS__
  23. #define __MOREFILESEXTRAS__
  24.  
  25. #include <Types.h>
  26. #include <Files.h>
  27.  
  28. #ifdef __cplusplus
  29. extern "C" {
  30. #endif
  31.  
  32. /*****************************************************************************/
  33.  
  34. /*
  35. **    Macros to get information out of GetVolParmsInfoBuffer
  36. */
  37.  
  38. #define    isNetworkVolume(volParms)    ((volParms).vMServerAdr != 0)
  39. #define    hasLimitFCBs(volParms)        (((volParms).vMAttrib & (1L << bLimitFCBs)) != 0)
  40. #define    hasLocalWList(volParms)        (((volParms).vMAttrib & (1L << bLocalWList)) != 0)
  41. #define    hasNoMiniFndr(volParms)        (((volParms).vMAttrib & (1L << bNoMiniFndr)) != 0)
  42. #define hasNoVNEdit(volParms)        (((volParms).vMAttrib & (1L << bNoVNEdit)) != 0)
  43. #define hasNoLclSync(volParms)        (((volParms).vMAttrib & (1L << bNoLclSync)) != 0)
  44. #define hasTrshOffLine(volParms)    (((volParms).vMAttrib & (1L << bTrshOffLine)) != 0)
  45. #define hasNoSwitchTo(volParms)        (((volParms).vMAttrib & (1L << bNoSwitchTo)) != 0)
  46. #define hasNoDeskItems(volParms)    (((volParms).vMAttrib & (1L << bNoDeskItems)) != 0)
  47. #define hasNoBootBlks(volParms)        (((volParms).vMAttrib & (1L << bNoBootBlks)) != 0)
  48. #define hasAccessCntl(volParms)        (((volParms).vMAttrib & (1L << bAccessCntl)) != 0)
  49. #define hasNoSysDir(volParms)        (((volParms).vMAttrib & (1L << bNoSysDir)) != 0)
  50. #define hasExtFSVol(volParms)        (((volParms).vMAttrib & (1L << bHasExtFSVol)) != 0)
  51. #define hasOpenDeny(volParms)        (((volParms).vMAttrib & (1L << bHasOpenDeny)) != 0)
  52. #define hasCopyFile(volParms)        (((volParms).vMAttrib & (1L << bHasCopyFile)) != 0)
  53. #define hasMoveRename(volParms)        (((volParms).vMAttrib & (1L << bHasMoveRename)) != 0)
  54. #define hasDesktopMgr(volParms)        (((volParms).vMAttrib & (1L << bHasDesktopMgr)) != 0)
  55. #define hasShortName(volParms)        (((volParms).vMAttrib & (1L << bHasShortName)) != 0)
  56. #define hasFolderLock(volParms)        (((volParms).vMAttrib & (1L << bHasFolderLock)) != 0)
  57. #define hasPersonalAccessPrivileges(volParms) \
  58.         (((volParms).vMAttrib & (1L << bHasPersonalAccessPrivileges)) != 0)
  59. #define hasUserGroupList(volParms)    (((volParms).vMAttrib & (1L << bHasUserGroupList)) != 0)
  60. #define hasCatSearch(volParms)        (((volParms).vMAttrib & (1L << bHasCatSearch)) != 0)
  61. #define hasFileIDs(volParms)        (((volParms).vMAttrib & (1L << bHasFileIDs)) != 0)
  62. #define hasBTreeMgr(volParms)        (((volParms).vMAttrib & (1L << bHasBTreeMgr)) != 0)
  63. #define hasBlankAccessPrivileges(volParms) \
  64.         (((volParms).vMAttrib & (1L << bHasBlankAccessPrivileges)) != 0)
  65.  
  66. /*****************************************************************************/
  67.  
  68. /*
  69. **    Deny mode permissions for use with the HOpenAware, HOpenRFAware,
  70. **    FSpOpenAware, and FSpOpenRFAware functions.
  71. */
  72.  
  73. enum
  74. {
  75.     dmNone            = 0x0000,
  76.     dmNoneDenyRd    = 0x0010,
  77.     dmNoneDenyWr    = 0x0020,
  78.     dmNoneDenyRdWr    = 0x0030,
  79.     dmRd            = 0x0001,    /* Single writer, multiple readers; the readers */
  80.     dmRdDenyRd        = 0x0011,
  81.     dmRdDenyWr        = 0x0021,    /* Browsing - equivalent to fsRdPerm */
  82.     dmRdDenyRdWr    = 0x0031,
  83.     dmWr            = 0x0002,
  84.     dmWrDenyRd        = 0x0012,
  85.     dmWrDenyWr        = 0x0022,
  86.     dmWrDenyRdWr    = 0x0032,
  87.     dmRdWr            = 0x0003,    /* Shared access - equivalent to fsRdWrShPerm */
  88.     dmRdWrDenyRd    = 0x0013,
  89.     dmRdWrDenyWr    = 0x0023,    /* Single writer, multiple readers; the writer */
  90.     dmRdWrDenyRdWr    = 0x0033    /* Exclusive access - equivalent to fsRdWrPerm */
  91. };
  92.     
  93. /*****************************************************************************/
  94.  
  95. #if PRAGMA_ALIGN_SUPPORTED
  96. #pragma options align=mac68k
  97. #endif
  98.  
  99. /*
  100. **    For those times where you need to use more than one kind of File Manager parameter
  101. **    block but don't feel like wasting stack space, here's a parameter block you can reuse.
  102. */
  103.  
  104. union UniversalFMPB
  105. {
  106.     ParamBlockRec    PB;
  107.     CInfoPBRec        ciPB;
  108.     DTPBRec            dtPB;
  109.     HParamBlockRec    hPB;
  110.     CMovePBRec        cmPB;
  111.     WDPBRec            wdPB;
  112.     FCBPBRec        fcbPB;
  113. };
  114. typedef union UniversalFMPB UniversalFMPB;
  115. typedef UniversalFMPB *UniversalFMPBPtr, **UniversalFMPBHandle;
  116.  
  117.  
  118. /*
  119. **    Used by GetUGEntries to return user or group lists
  120. */
  121.  
  122. struct UGEntry
  123. {
  124.     short    objType;    /* object type: -1 = group; 0 = user */
  125.     long    objID;        /* the user or group ID */
  126.     Str31    name;        /* the user or group name */
  127. };
  128. typedef struct UGEntry UGEntry;
  129. typedef UGEntry *UGEntryPtr, **UGEntryHandle;
  130.  
  131.  
  132. typedef unsigned char Str8[9];
  133.  
  134.  
  135. /*
  136. **    I use the following record instead of the AFPVolMountInfo structure in Files.h
  137. */
  138.  
  139. struct MyAFPVolMountInfo
  140. {
  141.     short length;                /* length of this record */
  142.     VolumeType media;            /* type of media, always AppleShareMediaType */
  143.     short flags;                /* 0 = normal mount; set bit 0 to inhibit greeting messages */
  144.     char nbpInterval;            /* NBP interval parameter; 7 is a good choice */
  145.     char nbpCount;                /* NBP count parameter; 5 is a good choice */
  146.     short uamType;                /* User Authentication Method */
  147.     short zoneNameOffset;        /* offset from start of record to zoneName */
  148.     short serverNameOffset;        /* offset from start of record to serverName */
  149.     short volNameOffset;        /* offset from start of record to volName */
  150.     short userNameOffset;        /* offset from start of record to userName */
  151.     short userPasswordOffset;    /* offset from start of record to userPassword */
  152.     short volPasswordOffset;    /* offset from start of record to volPassword */
  153.     Str31 zoneName;                /* server's AppleTalk zone name */                    
  154.     Str31 serverName;            /* server name */                    
  155.     Str27 volName;                /* volume name */                    
  156.     Str31 userName;                /* user name (zero length Pascal string for guest) */
  157.     Str8 userPassword;            /* user password (zero length Pascal string if no user password) */                    
  158.     char filler1;                /* to word align volPassword */
  159.     Str8 volPassword;            /* volume password (zero length Pascal string if no volume password) */                    
  160.     char filler2;                /* to end record on word boundry */
  161. };
  162. typedef struct MyAFPVolMountInfo MyAFPVolMountInfo;
  163. typedef MyAFPVolMountInfo *MyAFPVolMountInfoPtr, **MyAFPVolMountInfoHandle;
  164.  
  165. #if PRAGMA_ALIGN_SUPPORTED
  166. #pragma options align=reset
  167. #endif
  168.  
  169. /*****************************************************************************/
  170.  
  171. pascal    Ptr    GetTempBuffer(long buffReqSize,
  172.                           long *buffActSize);
  173. /*    ¶ Allocate a temporary copy or search buffer.
  174.     The GetTempBuffer function allocates a temporary buffer for file system
  175.     operations which is at least 1024 bytes (1K) and a multiple of
  176.     1024 bytes.
  177.     
  178.     buffReqSize        input:    Size you'd like the buffer to be.
  179.     buffActSize        output:    Size of buffer allocated.
  180.     function result    output:    Pointer to memory allocated or nil if no memory
  181.                             was available. The caller is responsible for
  182.                             disposing of this buffer with DisposePtr.
  183. */
  184.  
  185. /*****************************************************************************/
  186.  
  187. pascal    OSErr    DetermineVRefNum(StringPtr pathname,
  188.                                  short vRefNum,
  189.                                  short *realVRefNum);
  190. /*    ¶ Determine the real volume reference number.
  191.     The DetermineVRefNum function determines the volume reference number of
  192.     a volume from a pathname, a volume specification, or a combination
  193.     of the two.
  194.     WARNING: Volume names on the Macintosh are *not* unique -- Multiple
  195.     mounted volumes can have the same name. For this reason, the use of a
  196.     volume name or full pathname to identify a specific volume may not
  197.     produce the results you expect.  If more than one volume has the same
  198.     name and a volume name or full pathname is used, the File Manager
  199.     currently uses the first volume it finds with a matching name in the
  200.     volume queue.
  201.  
  202.     pathName    input:    Pointer to a full pathname or nil.  If you pass in a 
  203.                         partial pathname, it is ignored. A full pathname to a
  204.                         volume must end with a colon character (:).
  205.     vRefNum        input:    Volume specification (volume reference number, working
  206.                         directory number, drive number, or 0).
  207.     realVRefNum    output:    The real volume reference number.
  208. */
  209.  
  210. /*****************************************************************************/
  211.  
  212. pascal    OSErr    HGetVInfo(short volReference,
  213.                           StringPtr volName,
  214.                           short *vRefNum,
  215.                           unsigned long *freeBytes,
  216.                           unsigned long *totalBytes);
  217. /*    ¶ Get information about a mounted volume.
  218.     The HGetVInfo function returns the name, volume reference number,
  219.     available space (in bytes), and total space (in bytes) for the
  220.     specified volume. You can specify the volume by providing its drive
  221.     number, volume reference number, or 0 for the default volume.
  222.     This routine is compatible with volumes up to 4 gigabytes.
  223.     
  224.     volReference    input:    The drive number, volume reference number,
  225.                             or 0 for the default volume.
  226.     volName            input:    A pointer to a buffer (minimum Str27) where
  227.                             the volume name is to be returned or must
  228.                             be nil.
  229.                     output:    The volume name.
  230.     vRefNum            output:    The volume reference number.
  231.     freeBytes        output:    The number of free bytes on the volume.
  232.                             freeBytes is an unsigned long value.
  233.     totalBytes        output:    The total number of bytes on the volume.
  234.                             totalBytes is an unsigned long value.
  235.     
  236.     __________
  237.     
  238.     Also see:    XGetVInfo
  239. */
  240.  
  241. /*****************************************************************************/
  242.  
  243. pascal    OSErr    XGetVInfo(short volReference,
  244.                           StringPtr volName,
  245.                           short *vRefNum,
  246.                           UnsignedWide *freeBytes,
  247.                           UnsignedWide *totalBytes);
  248. /*    ¶ Get extended information about a mounted volume.
  249.     The XGetVInfo function returns the name, volume reference number,
  250.     available space (in bytes), and total space (in bytes) for the
  251.     specified volume. You can specify the volume by providing its drive
  252.     number, volume reference number, or 0 for the default volume.
  253.     This routine is compatible with volumes up to 2 terabytes.
  254.     
  255.     volReference    input:    The drive number, volume reference number,
  256.                             or 0 for the default volume.
  257.     volName            input:    A pointer to a buffer (minimum Str27) where
  258.                             the volume name is to be returned or must
  259.                             be nil.
  260.                     output:    The volume name.
  261.     vRefNum            output:    The volume reference number.
  262.     freeBytes        output:    The number of free bytes on the volume.
  263.                             freeBytes is an UnsignedWide value.
  264.     totalBytes        output:    The total number of bytes on the volume.
  265.                             totalBytes is an UnsignedWide value.
  266.     
  267.     __________
  268.     
  269.     Also see:    HGetVInfo
  270. */
  271.  
  272. /*****************************************************************************/
  273.  
  274. pascal    OSErr    CheckVolLock(StringPtr pathname,
  275.                              short vRefNum);
  276. /*    ¶ Determine if a volume is locked.
  277.     The CheckVolLock function determines if a volume is locked - either by
  278.     hardware or by software. If CheckVolLock returns noErr, then the volume
  279.     is not locked.
  280.  
  281.     pathName    input:    Pointer to a full pathname or nil.  If you pass in a 
  282.                         partial pathname, it is ignored. A full pathname to a
  283.                         volume must end with a colon character (:).
  284.     vRefNum        input:    Volume specification (volume reference number, working
  285.                         directory number, drive number, or 0).
  286. */
  287.  
  288. /*****************************************************************************/
  289.  
  290. pascal    OSErr GetDriverName(short driverRefNum,
  291.                             Str255 driverName);
  292. /*    ¶ Get a device driver's name.
  293.     The GetDriverName function returns a device driver's name.
  294.  
  295.     driverRefNum    input:    The driver reference number.
  296.     driverName        output:    The driver's name.
  297. */
  298.  
  299. /*****************************************************************************/
  300.  
  301. pascal    OSErr    FindDrive(StringPtr pathname,
  302.                           short vRefNum,
  303.                           DrvQElPtr *driveQElementPtr);
  304. /*    ¶ Find a volume's drive queue element in the drive queue.
  305.     The FindDrive function returns a pointer to a mounted volume's
  306.     drive queue element.
  307.  
  308.     pathName            input:    Pointer to a full pathname or nil. If you
  309.                                 pass in a partial pathname, it is ignored.
  310.                                 A full pathname to a volume must end with
  311.                                 a colon character (:).
  312.     vRefNum                input:    Volume specification (volume reference
  313.                                 number, working directory number, drive
  314.                                 number, or 0).
  315.     driveQElementPtr    output:    Pointer to a volume's drive queue element
  316.                                 in the drive queue. DO NOT change the
  317.                                 DrvQEl.
  318. */
  319.  
  320. /*****************************************************************************/
  321.  
  322. pascal    OSErr    GetDiskBlocks(StringPtr pathname,
  323.                               short vRefNum,
  324.                               unsigned long *numBlocks);
  325. /*    ¶ Return the number of physical disk blocks on a disk drive.
  326.     The GetDiskBlocks function returns the number of physical disk
  327.     blocks on a disk drive. NOTE: This is not the same as volume
  328.     allocation blocks!
  329.  
  330.     pathName    input:    Pointer to a full pathname or nil. If you
  331.                         pass in a partial pathname, it is ignored.
  332.                         A full pathname to a volume must end with
  333.                         a colon character (:).
  334.     vRefNum        input:    Volume specification (volume reference
  335.                         number, working directory number, drive
  336.                         number, or 0).
  337.     numBlocks    output:    The number of physical disk blocks on the disk drive.
  338. */
  339.  
  340. /*****************************************************************************/
  341.  
  342. pascal    OSErr    UnmountAndEject(StringPtr pathname,
  343.                                 short vRefNum);
  344. /*    ¶ Unmount and eject a volume.
  345.     The UnmountAndEject function unmounts and ejects a volume. The volume
  346.     is ejected only if it is ejectable and not already ejected.
  347.     
  348.     pathName    input:    Pointer to a full pathname or nil.  If you pass in a 
  349.                         partial pathname, it is ignored. A full pathname to a
  350.                         volume must end with a colon character (:).
  351.     vRefNum        input:    Volume specification (volume reference number, working
  352.                         directory number, drive number, or 0).
  353. */
  354.  
  355. /*****************************************************************************/
  356.  
  357. pascal    OSErr    OnLine(FSSpecPtr volumes,
  358.                        short reqVolCount,
  359.                        short *actVolCount,
  360.                        short *volIndex);
  361. /*    ¶ Return the list of volumes currently mounted.
  362.     The OnLine function returns the list of volumes currently mounted in
  363.     an array of FSSpec records.
  364.  
  365.     volumes        input:    Pointer to array of FSSpec where the volume list
  366.                         is returned.
  367.     reqVolCount    input:    Maximum number of volumes to return    (the number of
  368.                         elements in the volumes array).
  369.     actVolCount    output: The number of volumes actually returned.
  370.     volIndex    input:    The current volume index position. Set to 1 to
  371.                         start with the first volume.
  372.                 output:    The volume index position to get the next volume.
  373.                         Pass this value the next time you call OnLine to
  374.                         start where you left off.
  375. */
  376.  
  377. /*****************************************************************************/
  378.  
  379. pascal    OSErr SetDefault(short newVRefNum,
  380.                          long newDirID,
  381.                          short *oldVRefNum,
  382.                          long *oldDirID);
  383. /*    ¶ Set the default volume before making Standard I/O requests.
  384.     The SetDefault function sets the default volume and directory to the
  385.     volume specified by newVRefNum and the directory specified by newDirID.
  386.     The current default volume reference number and directory ID are
  387.     returned in oldVRefNum and oldDir and must be used to restore the
  388.     default volume and directory to their previous state *as soon as
  389.     possible* with the RestoreDefault function. These two functions are
  390.     designed to be used as a wrapper around Standard I/O routines where
  391.     the location of the file is implied to be the default volume and
  392.     directory. In other words, this is how you should use these functions:
  393.     
  394.         error = SetDefault(newVRefNum, newDirID, &oldVRefNum, &oldDirID);
  395.         if ( error == noErr )
  396.         {
  397.             // call the Stdio functions like remove, rename, tmpfile,
  398.             // fopen, freopen, etc. or non-ANSI extensions like
  399.             // fdopen,fsetfileinfo, -- create, open, unlink, etc. here!
  400.             
  401.             error = RestoreDefault(oldVRefNum, oldDirID);
  402.         }
  403.     
  404.     By using these functions as a wrapper, you won't need to open a working
  405.     directory (because SetDefault and RestoreDefault use HSetVol) and you
  406.     won't have to worry about the effects of using HSetVol (documented in
  407.     Technical Note "FL 11 - PBHSetVol is Dangerous" and in the
  408.     Inside Macintosh: Files book in the description of the HSetVol and 
  409.     PBHSetVol functions) because the default volume/directory is restored
  410.     before giving up control to code that might be affected by HSetVol.
  411.     
  412.     newVRefNum    input:    Volume specification (volume reference number,
  413.                         working directory number, drive number, or 0) of
  414.                         the new default volume.
  415.     newDirID    input:    Directory ID of the new default directory.
  416.     oldVRefNum    output: The volume specification to save for use with
  417.                         RestoreDefault.
  418.     oldDirID    output:    The directory ID to save for use with
  419.                         RestoreDefault.
  420.     
  421.     __________
  422.     
  423.     Also see:    RestoreDefault
  424. */
  425.  
  426. /*****************************************************************************/
  427.  
  428. pascal    OSErr RestoreDefault(short oldVRefNum,
  429.                              long oldDirID);
  430. /*    ¶ Restore the default volume after making Standard C I/O requests.
  431.     The RestoreDefault function restores the default volume and directory
  432.     to the volume specified by oldVRefNum and the directory specified by 
  433.     oldDirID. The oldVRefNum and oldDirID parameters were previously
  434.     obtained from the SetDefault function. These two functions are designed
  435.     to be used as a wrapper around Standard C I/O routines where the
  436.     location of the file is implied to be the default volume and directory.
  437.     In other words, this is how you should use these functions:
  438.     
  439.         error = SetDefault(newVRefNum, newDirID, &oldVRefNum, &oldDirID);
  440.         if ( error == noErr )
  441.         {
  442.             // call the Stdio functions like remove, rename, tmpfile,
  443.             // fopen, freopen, etc. or non-ANSI extensions like
  444.             // fdopen,fsetfileinfo, -- create, open, unlink, etc. here!
  445.             
  446.             error = RestoreDefault(oldVRefNum, oldDirID);
  447.         }
  448.     
  449.     By using these functions as a wrapper, you won't need to open a working
  450.     directory (because SetDefault and RestoreDefault use HSetVol) and you
  451.     won't have to worry about the effects of using HSetVol (documented in
  452.     Technical Note "FL 11 - PBHSetVol is Dangerous" and in the
  453.     Inside Macintosh: Files book in the description of the HSetVol and 
  454.     PBHSetVol functions) because the default volume/directory is restored
  455.     before giving up control to code that might be affected by HSetVol.
  456.     
  457.     oldVRefNum    input: The volume specification to restore.
  458.     oldDirID    input:    The directory ID to restore.
  459.     
  460.     __________
  461.     
  462.     Also see:    SetDefault
  463. */
  464.  
  465. /*****************************************************************************/
  466.  
  467. pascal    OSErr GetDInfo(short vRefNum,
  468.                        long dirID,
  469.                        StringPtr name,
  470.                        DInfo *fndrInfo);
  471. /*    ¶ Get the finder information for a directory.
  472.     The GetDInfo function gets the finder information for a directory.
  473.  
  474.     vRefNum            input:    Volume specification.
  475.     dirID            input:    Directory ID.
  476.     name            input:    Pointer to object name, or nil when dirID
  477.                             specifies a directory that's the object.
  478.     fndrInfo        output:    If the object is a directory, then its DInfo.
  479.  
  480.     __________
  481.     
  482.     Also see:    FSpGetDInfo, FSpGetFInfoCompat
  483. */
  484.  
  485. /*****************************************************************************/
  486.  
  487. pascal    OSErr FSpGetDInfo(const FSSpec *spec,
  488.                           DInfo *fndrInfo);
  489. /*    ¶ Get the finder information for a directory.
  490.     The FSpGetDInfo function gets the finder information for a directory.
  491.  
  492.     spec        input:    An FSSpec record specifying the directory.
  493.     fndrInfo    output:    If the object is a directory, then its DInfo.
  494.  
  495.     __________
  496.     
  497.     Also see:    FSpGetFInfoCompat, GetDInfo
  498. */
  499.  
  500. /*****************************************************************************/
  501.  
  502. pascal    OSErr SetDInfo(short vRefNum,
  503.                        long dirID,
  504.                        StringPtr name,
  505.                        const DInfo *fndrInfo);
  506. /*    ¶ Set the finder information for a directory.
  507.     The SetDInfo function sets the finder information for a directory.
  508.  
  509.     vRefNum            input:    Volume specification.
  510.     dirID            input:    Directory ID.
  511.     name            input:    Pointer to object name, or nil when dirID
  512.                             specifies a directory that's the object.
  513.     fndrInfo        input:    The DInfo.
  514.  
  515.     __________
  516.     
  517.     Also see:    FSpSetDInfo, FSpSetFInfoCompat
  518. */
  519.  
  520. /*****************************************************************************/
  521.  
  522. pascal    OSErr FSpSetDInfo(const FSSpec *spec,
  523.                           const DInfo *fndrInfo);
  524. /*    ¶ Set the finder information for a directory.
  525.     The FSpSetDInfo function sets the finder information for a directory.
  526.  
  527.     spec        input:    An FSSpec record specifying the directory.
  528.     fndrInfo    input:    The DInfo.
  529.  
  530.     __________
  531.     
  532.     Also see:    FSpSetFInfoCompat, SetDInfo
  533. */
  534.  
  535. /*****************************************************************************/
  536.  
  537. #if OLDROUTINENAMES
  538. #define    GetDirID(vRefNum, dirID, name, theDirID, isDirectory)    \
  539.         GetDirectoryID(vRefNum, dirID, name, theDirID, isDirectory)
  540. #endif
  541.  
  542. pascal    OSErr    GetDirectoryID(short vRefNum,
  543.                                long dirID,
  544.                                StringPtr name,
  545.                                long *theDirID,
  546.                                Boolean *isDirectory);
  547. /*    ¶ Get the directory ID number of the directory specified.
  548.     The GetDirectoryID function gets the directory ID number of the
  549.     directory specified.  If a file is specified, then the parent
  550.     directory of the file is returned and isDirectory is false.  If
  551.     a directory is specified, then that directory's ID number is
  552.     returned and isDirectory is true.
  553.     WARNING: Volume names on the Macintosh are *not* unique -- Multiple
  554.     mounted volumes can have the same name. For this reason, the use of a
  555.     volume name or full pathname to identify a specific volume may not
  556.     produce the results you expect.  If more than one volume has the same
  557.     name and a volume name or full pathname is used, the File Manager
  558.     currently uses the first volume it finds with a matching name in the
  559.     volume queue.
  560.     
  561.     vRefNum            input:    Volume specification.
  562.     dirID            input:    Directory ID.
  563.     name            input:    Pointer to object name, or nil when dirID
  564.                             specifies a directory that's the object.
  565.     theDirID        output:    If the object is a file, then its parent directory
  566.                             ID. If the object is a directory, then its ID.
  567.     isDirectory        output:    True if object is a directory; false if
  568.                             object is a file.
  569. */
  570.  
  571. /*****************************************************************************/
  572.  
  573. #if OLDROUTINENAMES
  574. #define    DirIDFromFSSpec(spec, theDirID, isDirectory)    \
  575.         FSpGetDirectoryID(spec, theDirID, isDirectory)
  576. #endif
  577.  
  578. pascal    OSErr    FSpGetDirectoryID(const FSSpec *spec,
  579.                                   long *theDirID,
  580.                                   Boolean *isDirectory);
  581. /*    ¶ Get the directory ID number of a directory.
  582.     The FSpGetDirectoryID function gets the directory ID number of the
  583.     directory specified by spec. If spec is to a file, then the parent
  584.     directory of the file is returned and isDirectory is false.  If
  585.     spec is to a directory, then that directory's ID number is
  586.     returned and isDirectory is true.
  587.     
  588.     spec            input:    An FSSpec record specifying the directory.
  589.     theDirID        output:    The directory ID.
  590.     isDirectory        output:    True if object is a directory; false if
  591.                             object is a file.
  592. */
  593.  
  594. /*****************************************************************************/
  595.  
  596. pascal    OSErr    GetDirName(short vRefNum,
  597.                            long dirID,
  598.                            StringPtr name);
  599. /*    ¶ Get the name of a directory from its directory ID.
  600.     The GetDirName function gets the name of a directory from its
  601.     directory ID.
  602.  
  603.     vRefNum        input:    Volume specification.
  604.     dirID        input:    Directory ID.
  605.     name        output:    Points to a buffer (minimum Str63) where the
  606.                         directory name is to be returned or must be nil.
  607. */
  608.  
  609. /*****************************************************************************/
  610.  
  611. pascal    OSErr    GetParentID(short vRefNum,
  612.                             long dirID,
  613.                             StringPtr name,
  614.                             long *parID);
  615. /*    ¶ Get the parent directory ID number of the specified object.
  616.     The GetParentID function gets the parent directory ID number of the
  617.     specified object.
  618.     
  619.     vRefNum        input:    Volume specification.
  620.     dirID        input:    Directory ID.
  621.     name        input:    Pointer to object name, or nil when dirID specifies
  622.                         a directory that's the object.
  623.     parID        output:    The parent directory ID of the specified object.
  624. */
  625.  
  626. /*****************************************************************************/
  627.  
  628. pascal    OSErr    GetFilenameFromPathname(ConstStr255Param pathname,
  629.                                         Str255 filename);
  630. /*    ¶ Get the object name from the end of a full or partial pathname.
  631.     The GetFilenameFromPathname function gets the file (or directory) name
  632.     from the end of a full or partial pathname. Returns notAFileErr if the
  633.     pathname is nil, the pathname is empty, or the pathname cannot refer to
  634.     a filename (with a noErr result, the pathname could still refer to a
  635.     directory).
  636.     
  637.     pathname    input:    A full or partial pathname.
  638.     filename    output:    The file (or directory) name.
  639.  
  640.     __________
  641.     
  642.     See also:    GetObjectLocation.
  643. */
  644.  
  645. /*****************************************************************************/
  646.  
  647. pascal    OSErr    GetObjectLocation(short vRefNum,
  648.                                   long dirID,
  649.                                   StringPtr pathname,
  650.                                   short *realVRefNum,
  651.                                   long *realParID,
  652.                                   Str255 realName,
  653.                                   Boolean *isDirectory);
  654. /*    ¶ Get a file system object's location.
  655.     The GetObjectLocation function gets a file system object's location -
  656.     that is, its real volume reference number, real parent directory ID,
  657.     and name. While we're at it, determine if the object is a file or directory.
  658.     If GetObjectLocation returns fnfErr, then the location information
  659.     returned is valid, but it describes an object that doesn't exist.
  660.     You can use the location information for another operation, such as
  661.     creating a file or directory.
  662.     
  663.     vRefNum        input:    Volume specification.
  664.     dirID        input:    Directory ID.
  665.     pathname    input:    Pointer to object name, or nil when dirID specifies
  666.                         a directory that's the object.
  667.     realVRefNum    output:    The real volume reference number.
  668.     realParID    output:    The parent directory ID of the specified object.
  669.     realName    output:    The name of the specified object (the case of the
  670.                         object name may not be the same as the object's
  671.                         catalog entry on disk - since the Macintosh file
  672.                         system is not case sensitive, it shouldn't matter).
  673.     isDirectory    output:    True if object is a directory; false if object
  674.                         is a file.
  675.  
  676.     __________
  677.     
  678.     See also:    FSMakeFSSpecCompat
  679. */
  680.  
  681. /*****************************************************************************/
  682.  
  683. pascal    OSErr    GetDirItems(short vRefNum,
  684.                             long dirID,
  685.                             StringPtr name,
  686.                             Boolean getFiles,
  687.                             Boolean getDirectories,
  688.                             FSSpecPtr items,
  689.                             short reqItemCount,
  690.                             short *actItemCount,
  691.                             short *itemIndex);
  692. /*    ¶ Return a list of items in a directory.
  693.     The GetDirItems function returns a list of items in the specified
  694.     directory in an array of FSSpec records. File, subdirectories, or
  695.     both can be returned in the list.
  696.  
  697.     vRefNum            input:    Volume specification.
  698.     dirID            input:    Directory ID.
  699.     name            input:    Pointer to object name, or nil when dirID
  700.                             specifies a directory that's the object.
  701.     getFiles        input:    Pass true to have files added to the items list.
  702.     getDirectories    input:    Pass true to have directories added to the
  703.                             items list.
  704.     items            input:    Pointer to array of FSSpec where the item list
  705.                             is returned.
  706.     reqItemCount    input:    Maximum number of items to return (the number
  707.                             of elements in the items array).
  708.     actItemCount    output: The number of items actually returned.
  709.     itemIndex        input:    The current item index position. Set to 1 to
  710.                             start with the first item in the directory.
  711.                     output:    The item index position to get the next item.
  712.                             Pass this value the next time you call
  713.                             GetDirItems to start where you left off.
  714. */
  715.  
  716. /*****************************************************************************/
  717.  
  718. pascal    OSErr    DeleteDirectoryContents(short vRefNum,
  719.                                          long dirID,
  720.                                         StringPtr name);
  721. /*    ¶ Delete the contents of a directory.
  722.     The DeleteDirectoryContents function deletes the contents of a directory.
  723.     All files and subdirectories in the specified directory are deleted.
  724.     If a locked file or directory is encountered, it is unlocked and then
  725.     deleted.  If any unexpected errors are encountered,
  726.     DeleteDirectoryContents quits and returns to the caller.
  727.     
  728.     vRefNum    input:    Volume specification.
  729.     dirID    input:    Directory ID.
  730.     name    input:    Pointer to directory name, or nil when dirID specifies
  731.                     a directory that's the object.
  732.  
  733.     __________
  734.     
  735.     Also see:    DeleteDirectory
  736. */
  737.  
  738. /*****************************************************************************/
  739.  
  740. pascal    OSErr    DeleteDirectory(short vRefNum,
  741.                                 long dirID,
  742.                                 StringPtr name);
  743. /*    ¶ Delete a directory and its contents.
  744.     The DeleteDirectory function deletes a directory and its contents.
  745.     All files and subdirectories in the specified directory are deleted.
  746.     If a locked file or directory is encountered, it is unlocked and then
  747.     deleted.  After deleting the directories contents, the directory is
  748.     deleted. If any unexpected errors are encountered, DeleteDirectory
  749.     quits and returns to the caller.
  750.     
  751.     vRefNum    input:    Volume specification.
  752.     dirID    input:    Directory ID.
  753.     name    input:    Pointer to directory name, or nil when dirID specifies
  754.                     a directory that's the object.
  755.  
  756.     __________
  757.     
  758.     Also see:    DeleteDirectoryContents
  759. */
  760.  
  761. /*****************************************************************************/
  762.  
  763. pascal    OSErr    CheckObjectLock(short vRefNum,
  764.                                 long dirID,
  765.                                 StringPtr name);
  766. /*    ¶ Determine if a file or directory is locked.
  767.     The CheckObjectLock function determines if a file or directory is locked.
  768.     If CheckObjectLock returns noErr, then the file or directory
  769.     is not locked.
  770.     
  771.     vRefNum    input:    Volume specification.
  772.     dirID    input:    Directory ID.
  773.     name    input:    Pointer to object name, or nil when dirID specifies
  774.                     a directory that's the object.
  775.  
  776.     __________
  777.     
  778.     Also see:    FSpCheckObjectLock
  779. */
  780.  
  781. /*****************************************************************************/
  782.  
  783. pascal    OSErr    FSpCheckObjectLock(const FSSpec *spec);
  784. /*    ¶ Determine if a file or directory is locked.
  785.     The FSpCheckObjectLock function determines if a file or directory is locked.
  786.     If FSpCheckObjectLock returns noErr, then the file or directory
  787.     is not locked.
  788.     
  789.     spec    input:    An FSSpec record specifying the object.
  790.  
  791.     __________
  792.     
  793.     Also see:    CheckObjectLock
  794. */
  795.  
  796. /*****************************************************************************/
  797.  
  798. pascal    OSErr    GetFileSize(short vRefNum,
  799.                             long dirID,
  800.                             ConstStr255Param fileName,
  801.                             long *dataSize,
  802.                             long *rsrcSize);
  803. /*    ¶ Get the logical sizes of a file's forks.
  804.     The GetFileSize function returns the logical size of a file's
  805.     data and resource fork.
  806.     
  807.     vRefNum        input:    Volume specification.
  808.     dirID        input:    Directory ID.
  809.     name        input:    The name of the file.
  810.     dataSize    output:    The number of bytes in the file's data fork.
  811.     rsrcSize    output:    The number of bytes in the file's resource fork.
  812.  
  813.     __________
  814.     
  815.     See also:    FSpGetFileSize
  816. */
  817.  
  818. /*****************************************************************************/
  819.  
  820. pascal    OSErr    FSpGetFileSize(const FSSpec *spec,
  821.                                long *dataSize,
  822.                                long *rsrcSize);
  823. /*    ¶ Get the logical sizes of a file's forks.
  824.     The FSpGetFileSize function returns the logical size of a file's
  825.     data and resource fork.
  826.     
  827.     spec        input:    An FSSpec record specifying the file.
  828.     dataSize    output:    The number of bytes in the file's data fork.
  829.     rsrcSize    output:    The number of bytes in the file's resource fork.
  830.  
  831.     __________
  832.     
  833.     See also:    GetFileSize
  834. */
  835.  
  836. /*****************************************************************************/
  837.  
  838. pascal    OSErr    BumpDate(short vRefNum,
  839.                          long dirID,
  840.                          StringPtr name);
  841. /*    ¶ Update the modification date of a file or directory.
  842.     The BumpDate function changes the modification date of a file or
  843.     directory to the current date/time.  If the modification date is already
  844.     equal to the current date/time, then add one second to the
  845.     modification date.
  846.     
  847.     vRefNum    input:    Volume specification.
  848.     dirID    input:    Directory ID.
  849.     name    input:    Pointer to object name, or nil when dirID specifies
  850.                     a directory that's the object.
  851.  
  852.     __________
  853.     
  854.     See also:    FSpBumpDate
  855. */
  856.  
  857. /*****************************************************************************/
  858.  
  859. pascal    OSErr    FSpBumpDate(const FSSpec *spec);
  860. /*    ¶ Update the modification date of a file or directory.
  861.     The FSpBumpDate function changes the modification date of a file or
  862.     directory to the current date/time.  If the modification date is already
  863.     equal to the current date/time, then add one second to the
  864.     modification date.
  865.     
  866.     spec    input:    An FSSpec record specifying the object.
  867.  
  868.     __________
  869.     
  870.     See also:    BumpDate
  871. */
  872.  
  873. /*****************************************************************************/
  874.  
  875. pascal    OSErr    ChangeCreatorType(short vRefNum,
  876.                                   long dirID,
  877.                                   ConstStr255Param name,
  878.                                   OSType creator,
  879.                                   OSType fileType);
  880. /*    ¶ Change the creator or file type of a file.
  881.     The ChangeCreatorType function changes the creator or file type of a file.
  882.  
  883.     vRefNum        input:    Volume specification.
  884.     dirID        input:    Directory ID.
  885.     name        input:    The name of the file.
  886.     creator        input:    The new creator type or 0x00000000 to leave
  887.                         the creator type alone.
  888.     fileType    input:    The new file type or 0x00000000 to leave the
  889.                         file type alone.
  890.  
  891.     __________
  892.     
  893.     See also:    FSpChangeCreatorType
  894. */
  895.  
  896. /*****************************************************************************/
  897.  
  898. pascal    OSErr    FSpChangeCreatorType(const FSSpec *spec,
  899.                                      OSType creator,
  900.                                      OSType fileType);
  901. /*    ¶ Change the creator or file type of a file.
  902.     The FSpChangeCreatorType function changes the creator or file type of a file.
  903.  
  904.     spec        input:    An FSSpec record specifying the file.
  905.     creator        input:    The new creator type or 0x00000000 to leave
  906.                         the creator type alone.
  907.     fileType    input:    The new file type or 0x00000000 to leave the
  908.                         file type alone.
  909.  
  910.     __________
  911.     
  912.     See also:    ChangeCreatorType
  913. */
  914.  
  915. /*****************************************************************************/
  916.  
  917. pascal    OSErr    ChangeFDFlags(short vRefNum,
  918.                               long dirID,
  919.                               StringPtr name,
  920.                               Boolean    setBits,
  921.                               unsigned short flagBits);
  922. /*    ¶ Set or clear Finder Flag bits.
  923.     The ChangeFDFlags function sets or clears Finder Flag bits in the
  924.     fdFlags field of a file or directory's FInfo record.
  925.     
  926.     vRefNum        input:    Volume specification.
  927.     dirID        input:    Directory ID.
  928.     name        input:    Pointer to object name, or nil when dirID specifies
  929.                         a directory that's the object.
  930.     setBits        input:    If true, then set the bits specified in flagBits.
  931.                         If false, then clear the bits specified in flagBits.
  932.     flagBits    input:    The flagBits parameter specifies which Finder Flag
  933.                         bits to set or clear. If a bit in flagBits is set,
  934.                         then the same bit in fdFlags is either set or
  935.                         cleared depending on the state of the setBits
  936.                         parameter.
  937.  
  938.     __________
  939.     
  940.     See also:    FSpChangeFDFlags
  941. */
  942.  
  943. /*****************************************************************************/
  944.  
  945. pascal    OSErr    FSpChangeFDFlags(const FSSpec *spec,
  946.                                  Boolean setBits,
  947.                                  unsigned short flagBits);
  948. /*    ¶ Set or clear Finder Flag bits.
  949.     The FSpChangeFDFlags function sets or clears Finder Flag bits in the
  950.     fdFlags field of a file or directory's FInfo record.
  951.     
  952.     spec        input:    An FSSpec record specifying the object.
  953.     setBits        input:    If true, then set the bits specified in flagBits.
  954.                         If false, then clear the bits specified in flagBits.
  955.     flagBits    input:    The flagBits parameter specifies which Finder Flag
  956.                         bits to set or clear. If a bit in flagBits is set,
  957.                         then the same bit in fdFlags is either set or
  958.                         cleared depending on the state of the setBits
  959.                         parameter.
  960.  
  961.     __________
  962.     
  963.     See also:    ChangeFDFlags
  964. */
  965.  
  966. /*****************************************************************************/
  967.  
  968. pascal    OSErr    SetIsInvisible(short vRefNum,
  969.                                long dirID,
  970.                                StringPtr name);
  971. /*    ¶ Set the invisible Finder Flag bit.
  972.     The SetIsInvisible function sets the invisible bit in the fdFlags
  973.     word of the specified file or directory's finder information.
  974.     
  975.     vRefNum    input:    Volume specification.
  976.     dirID    input:    Directory ID.
  977.     name    input:    Pointer to object name, or nil when dirID specifies
  978.                     a directory that's the object.
  979.  
  980.     __________
  981.     
  982.     See also:    FSpSetIsInvisible, ClearIsInvisible, FSpClearIsInvisible
  983. */
  984.  
  985. /*****************************************************************************/
  986.  
  987. pascal    OSErr    FSpSetIsInvisible(const FSSpec *spec);
  988. /*    ¶ Set the invisible Finder Flag bit.
  989.     The FSpSetIsInvisible function sets the invisible bit in the fdFlags
  990.     word of the specified file or directory's finder information.
  991.     
  992.     spec    input:    An FSSpec record specifying the object.
  993.  
  994.     __________
  995.     
  996.     See also:    SetIsInvisible, ClearIsInvisible, FSpClearIsInvisible
  997. */
  998.  
  999. /*****************************************************************************/
  1000.  
  1001. pascal    OSErr    ClearIsInvisible(short vRefNum,
  1002.                                  long dirID,
  1003.                                  StringPtr name);
  1004. /*    ¶ Clear the invisible Finder Flag bit.
  1005.     The ClearIsInvisible function clears the invisible bit in the fdFlags
  1006.     word of the specified file or directory's finder information.
  1007.     
  1008.     vRefNum    input:    Volume specification.
  1009.     dirID    input:    Directory ID.
  1010.     name    input:    Pointer to object name, or nil when dirID specifies
  1011.                     a directory that's the object.
  1012.  
  1013.     __________
  1014.     
  1015.     See also:    SetIsInvisible, FSpSetIsInvisible, FSpClearIsInvisible
  1016. */
  1017.  
  1018. /*****************************************************************************/
  1019.  
  1020. pascal    OSErr    FSpClearIsInvisible(const FSSpec *spec);
  1021. /*    ¶ Clear the invisible Finder Flag bit.
  1022.     The FSpClearIsInvisible function clears the invisible bit in the fdFlags
  1023.     word of the specified file or directory's finder information.
  1024.     
  1025.     spec    input:    An FSSpec record specifying the object.
  1026.  
  1027.     __________
  1028.     
  1029.     See also:    SetIsInvisible, FSpSetIsInvisible, ClearIsInvisible
  1030. */
  1031.  
  1032. /*****************************************************************************/
  1033.  
  1034. pascal    OSErr    SetNameLocked(short vRefNum,
  1035.                               long dirID,
  1036.                               StringPtr name);
  1037. /*    ¶ Set the nameLocked Finder Flag bit.
  1038.     The SetNameLocked function sets the nameLocked bit in the fdFlags word
  1039.     of the specified file or directory's finder information.
  1040.     
  1041.     vRefNum    input:    Volume specification.
  1042.     dirID    input:    Directory ID.
  1043.     name    input:    Pointer to object name, or nil when dirID specifies
  1044.                     a directory that's the object.
  1045.  
  1046.     __________
  1047.     
  1048.     See also:    FSpSetNameLocked, ClearNameLocked, FSpClearNameLocked
  1049. */
  1050.  
  1051. /*****************************************************************************/
  1052.  
  1053. pascal    OSErr    FSpSetNameLocked(const FSSpec *spec);
  1054. /*    ¶ Set the nameLocked Finder Flag bit.
  1055.     The FSpSetNameLocked function sets the nameLocked bit in the fdFlags word
  1056.     of the specified file or directory's finder information.
  1057.     
  1058.     spec    input:    An FSSpec record specifying the object.
  1059.  
  1060.     __________
  1061.     
  1062.     See also:    SetNameLocked, ClearNameLocked, FSpClearNameLocked
  1063. */
  1064.  
  1065. /*****************************************************************************/
  1066.  
  1067. pascal    OSErr    ClearNameLocked(short vRefNum,
  1068.                                 long dirID,
  1069.                                 StringPtr name);
  1070. /*    ¶ Clear the nameLocked Finder Flag bit.
  1071.     The ClearNameLocked function clears the nameLocked bit in the fdFlags
  1072.     word of the specified file or directory's finder information.
  1073.     
  1074.     vRefNum    input:    Volume specification.
  1075.     dirID    input:    Directory ID.
  1076.     name    input:    Pointer to object name, or nil when dirID specifies
  1077.                     a directory that's the object.
  1078.  
  1079.     __________
  1080.     
  1081.     See also:    SetNameLocked, FSpSetNameLocked, FSpClearNameLocked
  1082. */
  1083.  
  1084. /*****************************************************************************/
  1085.  
  1086. pascal    OSErr    FSpClearNameLocked(const FSSpec *spec);
  1087. /*    ¶ Clear the nameLocked Finder Flag bit.
  1088.     The FSpClearNameLocked function clears the nameLocked bit in the fdFlags
  1089.     word of the specified file or directory's finder information.
  1090.     
  1091.     spec    input:    An FSSpec record specifying the object.
  1092.  
  1093.     __________
  1094.     
  1095.     See also:    SetNameLocked, FSpSetNameLocked, ClearNameLocked
  1096. */
  1097.  
  1098. /*****************************************************************************/
  1099.  
  1100. pascal    OSErr    SetIsStationery(short vRefNum,
  1101.                                 long dirID,
  1102.                                 ConstStr255Param name);
  1103. /*    ¶ Set the isStationery Finder Flag bit.
  1104.     The SetIsStationery function sets the isStationery bit in the
  1105.     fdFlags word of the specified file or directory's finder information.
  1106.     
  1107.     vRefNum    input:    Volume specification.
  1108.     dirID    input:    Directory ID.
  1109.     name    input:    Pointer to object name, or nil when dirID specifies
  1110.                     a directory that's the object.
  1111.  
  1112.     __________
  1113.     
  1114.     See also:    FSpSetIsStationery, ClearIsStationery, FSpClearIsStationery
  1115. */
  1116.  
  1117. /*****************************************************************************/
  1118.  
  1119. pascal    OSErr    FSpSetIsStationery(const FSSpec *spec);
  1120. /*    ¶ Set the isStationery Finder Flag bit.
  1121.     The FSpSetIsStationery function sets the isStationery bit in the
  1122.     fdFlags word of the specified file or directory's finder information.
  1123.     
  1124.     spec    input:    An FSSpec record specifying the object.
  1125.  
  1126.     __________
  1127.     
  1128.     See also:    SetIsStationery, ClearIsStationery, FSpClearIsStationery
  1129. */
  1130.  
  1131. /*****************************************************************************/
  1132.  
  1133. pascal    OSErr    ClearIsStationery(short vRefNum,
  1134.                                   long dirID,
  1135.                                   ConstStr255Param name);
  1136. /*    ¶ Clear the isStationery Finder Flag bit.
  1137.     The ClearIsStationery function clears the isStationery bit in the
  1138.     fdFlags word of the specified file or directory's finder information.
  1139.     
  1140.     vRefNum    input:    Volume specification.
  1141.     dirID    input:    Directory ID.
  1142.     name    input:    Pointer to object name, or nil when dirID specifies
  1143.                     a directory that's the object.
  1144.  
  1145.     __________
  1146.     
  1147.     See also:    SetIsStationery, FSpSetIsStationery, FSpClearIsStationery
  1148. */
  1149.  
  1150. /*****************************************************************************/
  1151.  
  1152. pascal    OSErr    FSpClearIsStationery(const FSSpec *spec);
  1153. /*    ¶ Clear the isStationery Finder Flag bit.
  1154.     The FSpClearIsStationery function clears the isStationery bit in the
  1155.     fdFlags word of the specified file or directory's finder information.
  1156.     
  1157.     spec    input:    An FSSpec record specifying the object.
  1158.  
  1159.     __________
  1160.     
  1161.     See also:    SetIsStationery, FSpSetIsStationery, ClearIsStationery
  1162. */
  1163.  
  1164. /*****************************************************************************/
  1165.  
  1166. pascal    OSErr    SetHasCustomIcon(short vRefNum,
  1167.                                  long dirID,
  1168.                                  StringPtr name);
  1169. /*    ¶ Set the hasCustomIcon Finder Flag bit.
  1170.     The SetHasCustomIcon function sets the hasCustomIcon bit in the
  1171.     fdFlags word of the specified file or directory's finder information.
  1172.     
  1173.     vRefNum    input:    Volume specification.
  1174.     dirID    input:    Directory ID.
  1175.     name    input:    Pointer to object name, or nil when dirID specifies
  1176.                     a directory that's the object.
  1177.  
  1178.     __________
  1179.     
  1180.     See also:    FSpSetHasCustomIcon, ClearHasCustomIcon, FSpClearHasCustomIcon
  1181. */
  1182.  
  1183. /*****************************************************************************/
  1184.  
  1185. pascal    OSErr    FSpSetHasCustomIcon(const FSSpec *spec);
  1186. /*    ¶ Set the hasCustomIcon Finder Flag bit.
  1187.     The FSpSetHasCustomIcon function sets the hasCustomIcon bit in the
  1188.     fdFlags word of the specified file or directory's finder information.
  1189.     
  1190.     spec    input:    An FSSpec record specifying the object.
  1191.  
  1192.     __________
  1193.     
  1194.     See also:    SetHasCustomIcon, ClearHasCustomIcon, FSpClearHasCustomIcon
  1195. */
  1196.  
  1197. /*****************************************************************************/
  1198.  
  1199. pascal    OSErr    ClearHasCustomIcon(short vRefNum,
  1200.                                    long dirID,
  1201.                                    StringPtr name);
  1202. /*    ¶ Clear the hasCustomIcon Finder Flag bit.
  1203.     The ClearHasCustomIcon function clears the hasCustomIcon bit in the
  1204.     fdFlags word of the specified file or directory's finder information.
  1205.     
  1206.     vRefNum    input:    Volume specification.
  1207.     dirID    input:    Directory ID.
  1208.     name    input:    Pointer to object name, or nil when dirID specifies
  1209.                     a directory that's the object.
  1210.  
  1211.     __________
  1212.     
  1213.     See also:    SetHasCustomIcon, FSpSetHasCustomIcon, FSpClearHasCustomIcon
  1214. */
  1215.  
  1216. /*****************************************************************************/
  1217.  
  1218. pascal    OSErr    FSpClearHasCustomIcon(const FSSpec *spec);
  1219. /*    ¶ Clear the hasCustomIcon Finder Flag bit.
  1220.     The FSpClearHasCustomIcon function clears the hasCustomIcon bit in the
  1221.     fdFlags word of the specified file or directory's finder information.
  1222.     
  1223.     spec    input:    An FSSpec record specifying the object.
  1224.  
  1225.     __________
  1226.     
  1227.     See also:    SetHasCustomIcon, FSpSetHasCustomIcon, ClearHasCustomIcon
  1228. */
  1229.  
  1230. /*****************************************************************************/
  1231.  
  1232. pascal    OSErr    ClearHasBeenInited(short vRefNum,
  1233.                                    long dirID,
  1234.                                    StringPtr name);
  1235. /*    ¶ Clear the hasBeenInited Finder Flag bit.
  1236.     The ClearHasBeenInited function clears the hasBeenInited bit in the
  1237.     fdFlags word of the specified file or directory's finder information.
  1238.     
  1239.     vRefNum    input:    Volume specification.
  1240.     dirID    input:    Directory ID.
  1241.     name    input:    Pointer to object name, or nil when dirID specifies
  1242.                     a directory that's the object.
  1243.  
  1244.     __________
  1245.     
  1246.     See also:    FSpClearHasBeenInited
  1247. */
  1248.  
  1249. /*****************************************************************************/
  1250.  
  1251. pascal    OSErr    FSpClearHasBeenInited(const FSSpec *spec);
  1252. /*    ¶ Clear the hasBeenInited Finder Flag bit.
  1253.     The FSpClearHasBeenInited function clears the hasBeenInited bit in the
  1254.     fdFlags word of the specified file or directory's finder information.
  1255.     
  1256.     spec    input:    An FSSpec record specifying the object.
  1257.  
  1258.     __________
  1259.     
  1260.     See also:    ClearHasBeenInited
  1261. */
  1262.  
  1263. /*****************************************************************************/
  1264.  
  1265. pascal    OSErr    CopyFileMgrAttributes(short srcVRefNum,
  1266.                                       long srcDirID,
  1267.                                       StringPtr srcName,
  1268.                                       short dstVRefNum,
  1269.                                       long dstDirID,
  1270.                                       StringPtr dstName,
  1271.                                       Boolean copyLockBit);
  1272. /*    ¶ Copy all File Manager attributes from the source to the destination.
  1273.     The CopyFileMgrAttributes function copies all File Manager attributes
  1274.     from the source file or directory to the destination file or directory.
  1275.     If copyLockBit is true, then set the locked state of the destination
  1276.     to match the source.
  1277.  
  1278.     srcVRefNum    input:    Source volume specification.
  1279.     srcDirID    input:    Source directory ID.
  1280.     srcName        input:    Pointer to source object name, or nil when
  1281.                         srcDirID specifies a directory that's the object.
  1282.     dstVRefNum    input:    Destination volume specification.
  1283.     dstDirID    input:    Destination directory ID.
  1284.     dstName        input:    Pointer to destination object name, or nil when
  1285.                         dstDirID specifies a directory that's the object.
  1286.     copyLockBit    input:    If true, set the locked state of the destination
  1287.                         to match the source.
  1288.  
  1289.     __________
  1290.     
  1291.     See also:    FSpCopyFileMgrAttributes
  1292. */
  1293.  
  1294. /*****************************************************************************/
  1295.  
  1296. pascal    OSErr    FSpCopyFileMgrAttributes(const FSSpec *srcSpec,
  1297.                                          const FSSpec *dstSpec,
  1298.                                          Boolean copyLockBit);
  1299. /*    ¶ Copy all File Manager attributes from the source to the destination.
  1300.     The FSpCopyFileMgrAttributes function copies all File Manager attributes
  1301.     from the source file or directory to the destination file or directory.
  1302.     If copyLockBit is true, then set the locked state of the destination
  1303.     to match the source.
  1304.  
  1305.     srcSpec        input:    An FSSpec record specifying the source object.
  1306.     dstSpec        input:    An FSSpec record specifying the destination object.
  1307.     copyLockBit    input:    If true, set the locked state of the destination
  1308.                         to match the source.
  1309.  
  1310.     __________
  1311.     
  1312.     See also:    CopyFileMgrAttributes
  1313. */
  1314.  
  1315. /*****************************************************************************/
  1316.  
  1317. pascal    OSErr    HOpenAware(short vRefNum,
  1318.                            long dirID,
  1319.                            ConstStr255Param fileName,
  1320.                            short denyModes,
  1321.                            short *refNum);
  1322. /*    ¶ Open the data fork of a file using deny mode permissions.
  1323.     The HOpenAware function opens the data fork of a file using deny mode
  1324.     permissions instead the normal File Manager permissions.  If OpenDeny
  1325.     is not available, then HOpenAware translates the deny modes to the
  1326.     closest File Manager permissions and tries to open the file with
  1327.     OpenDF first, and then Open if OpenDF isn't available. By using
  1328.     HOpenAware with deny mode permissions, a program can be "AppleShare
  1329.     aware" and fall back on the standard File Manager open calls
  1330.     automatically.
  1331.  
  1332.     vRefNum        input:    Volume specification.
  1333.     dirID        input:    Directory ID.
  1334.     fileName    input:    The name of the file.
  1335.     denyModes    input:    The deny modes access under which to open the file.
  1336.     refNum        output:    The file reference number of the opened file.
  1337.  
  1338.     __________
  1339.     
  1340.     See also:    FSpOpenAware, HOpenRFAware, FSpOpenRFAware
  1341. */
  1342.  
  1343. /*****************************************************************************/
  1344.  
  1345. pascal    OSErr    FSpOpenAware(const FSSpec *spec,
  1346.                              short denyModes,
  1347.                              short *refNum);
  1348. /*    ¶ Open the data fork of a file using deny mode permissions.
  1349.     The FSpOpenAware function opens the data fork of a file using deny mode
  1350.     permissions instead the normal File Manager permissions.  If OpenDeny
  1351.     is not available, then FSpOpenAware translates the deny modes to the
  1352.     closest File Manager permissions and tries to open the file with
  1353.     OpenDF first, and then Open if OpenDF isn't available. By using
  1354.     FSpOpenAware with deny mode permissions, a program can be "AppleShare
  1355.     aware" and fall back on the standard File Manager open calls
  1356.     automatically.
  1357.  
  1358.     spec        input:    An FSSpec record specifying the file.
  1359.     denyModes    input:    The deny modes access under which to open the file.
  1360.     refNum        output:    The file reference number of the opened file.
  1361.  
  1362.     __________
  1363.     
  1364.     See also:    HOpenAware, HOpenRFAware, FSpOpenRFAware
  1365. */
  1366.  
  1367. /*****************************************************************************/
  1368.  
  1369. pascal    OSErr    HOpenRFAware(short vRefNum,
  1370.                              long dirID,
  1371.                              ConstStr255Param fileName,
  1372.                              short denyModes,
  1373.                              short *refNum);
  1374. /*    ¶ Open the resource fork of a file using deny mode permissions.
  1375.     The HOpenRFAware function opens the resource fork of a file using deny
  1376.     mode permissions instead the normal File Manager permissions.  If
  1377.     OpenRFDeny is not available, then HOpenRFAware translates the deny
  1378.     modes to the closest File Manager permissions and tries to open the
  1379.     file with OpenRF. By using HOpenRFAware with deny mode permissions,
  1380.     a program can be "AppleShare aware" and fall back on the standard
  1381.     File Manager open calls automatically.
  1382.  
  1383.     vRefNum        input:    Volume specification.
  1384.     dirID        input:    Directory ID.
  1385.     fileName    input:    The name of the file.
  1386.     denyModes    input:    The deny modes access under which to open the file.
  1387.     refNum        output:    The file reference number of the opened file.
  1388.  
  1389.     __________
  1390.     
  1391.     See also:    HOpenAware, FSpOpenAware, FSpOpenRFAware
  1392. */
  1393.  
  1394. /*****************************************************************************/
  1395.  
  1396. pascal    OSErr    FSpOpenRFAware(const FSSpec *spec,
  1397.                                short denyModes,
  1398.                                short *refNum);
  1399. /*    ¶ Open the resource fork of a file using deny mode permissions.
  1400.     The FSpOpenRFAware function opens the resource fork of a file using deny
  1401.     mode permissions instead the normal File Manager permissions.  If
  1402.     OpenRFDeny is not available, then FSpOpenRFAware translates the deny
  1403.     modes to the closest File Manager permissions and tries to open the
  1404.     file with OpenRF. By using FSpOpenRFAware with deny mode permissions,
  1405.     a program can be "AppleShare aware" and fall back on the standard
  1406.     File Manager open calls automatically.
  1407.  
  1408.     spec        input:    An FSSpec record specifying the file.
  1409.     denyModes    input:    The deny modes access under which to open the file.
  1410.     refNum        output:    The file reference number of the opened file.
  1411.  
  1412.     __________
  1413.     
  1414.     See also:    HOpenAware, FSpOpenAware, HOpenRFAware
  1415. */
  1416.  
  1417. /*****************************************************************************/
  1418.  
  1419. pascal    OSErr    FSReadNoCache(short refNum,
  1420.                               long *count,
  1421.                               void *buffPtr);
  1422. /*    ¶ Read any number of bytes from an open file requesting no caching.
  1423.     The FSReadNoCache function reads any number of bytes from an open file
  1424.     while asking the file system to bypass its cache mechanism.
  1425.     
  1426.     refNum    input:    The file reference number of an open file.
  1427.     count    input:    The number of bytes to read.
  1428.             output:    The number of bytes actually read.
  1429.     buffPtr    input:    A pointer to the data buffer into which the bytes are
  1430.                     to be read.
  1431.  
  1432.     __________
  1433.     
  1434.     See also:    FSWriteNoCache
  1435. */
  1436.  
  1437. /*****************************************************************************/
  1438.  
  1439. pascal    OSErr    FSWriteNoCache(short refNum,
  1440.                                long *count,
  1441.                                const void *buffPtr);
  1442. /*    ¶ Write any number of bytes to an open file requesting no caching.
  1443.     The FSReadNoCache function writes any number of bytes to an open file
  1444.     while asking the file system to bypass its cache mechanism.
  1445.     
  1446.     refNum    input:    The file reference number of an open file.
  1447.     count    input:    The number of bytes to write to the file.
  1448.             output:    The number of bytes actually written.
  1449.     buffPtr    input:    A pointer to the data buffer from which the bytes are
  1450.                     to be written.
  1451.  
  1452.     __________
  1453.     
  1454.     See also:    FSReadNoCache
  1455. */
  1456.  
  1457. /*****************************************************************************/
  1458.  
  1459. pascal    OSErr    FSWriteVerify(short refNum,
  1460.                               long *count,
  1461.                               const void *buffPtr);
  1462. /*    ¶ Write any number of bytes to an open file and then verify the data was written.
  1463.     The FSWriteVerify function writes any number of bytes to an open file
  1464.     and then verifies that the data was actually written to the device.
  1465.     
  1466.     refNum    input:    The file reference number of an open file.
  1467.     count    input:    The number of bytes to write to the file.
  1468.             output:    The number of bytes actually written and verified.
  1469.     buffPtr    input:    A pointer to the data buffer from which the bytes are
  1470.                     to be written.
  1471. */
  1472.  
  1473. /*****************************************************************************/
  1474.  
  1475. pascal    OSErr    CopyFork(short srcRefNum,
  1476.                          short dstRefNum,
  1477.                          void *copyBufferPtr,
  1478.                          long copyBufferSize);
  1479. /*    ¶ Copy all data from the source fork to the destination fork of open file forks.
  1480.     The CopyFork function copies all data from the source fork to the
  1481.     destination fork of open file forks and makes sure the destination EOF
  1482.     is equal to the source EOF.
  1483.     
  1484.     srcRefNum        input:    The source file reference number.
  1485.     dstRefNum        input:    The destination file reference number.
  1486.     copyBufferPtr    input:    Pointer to buffer to use during copy. The
  1487.                             buffer should be at least 512-bytes minimum.
  1488.                             The larger the buffer, the faster the copy.
  1489.     copyBufferSize    input:    The size of the copy buffer.
  1490. */
  1491.  
  1492. /*****************************************************************************/
  1493.  
  1494. pascal    OSErr    GetFileLocation(short refNum,
  1495.                                 short *vRefNum,
  1496.                                 long *dirID,
  1497.                                 StringPtr fileName);
  1498. /*    ¶ Get the location of an open file.
  1499.     The GetFileLocation function gets the location (volume reference number,
  1500.     directory ID, and fileName) of an open file.
  1501.  
  1502.     refNum        input:    The file reference number of an open file.
  1503.     vRefNum        output:    The volume reference number.
  1504.     dirID        output:    The parent directory ID.
  1505.     fileName    input:    Points to a buffer (minimum Str63) where the
  1506.                         filename is to be returned or must be nil.
  1507.                 output:    The filename.
  1508.  
  1509.     __________
  1510.     
  1511.     See also:    FSpGetFileLocation
  1512. */
  1513.  
  1514. /*****************************************************************************/
  1515.  
  1516. pascal    OSErr    FSpGetFileLocation(short refNum,
  1517.                                    FSSpec *spec);
  1518. /*    ¶ Get the location of an open file in an FSSpec record.
  1519.     The FSpGetFileLocation function gets the location of an open file in
  1520.     an FSSpec record.
  1521.  
  1522.     refNum        input:    The file reference number of an open file.
  1523.     spec        output:    FSSpec record containing the file name and location.
  1524.  
  1525.     __________
  1526.     
  1527.     See also:    GetFileLocation
  1528. */
  1529.  
  1530. /*****************************************************************************/
  1531.  
  1532. pascal    OSErr    CopyDirectoryAccess(short srcVRefNum,
  1533.                                     long srcDirID,
  1534.                                     StringPtr srcName,
  1535.                                     short dstVRefNum,
  1536.                                     long dstDirID,
  1537.                                     StringPtr dstName);
  1538. /*    ¶ Copy the AFP directory access privileges.
  1539.     The CopyDirectoryAccess function copies the AFP directory access
  1540.     privileges from one directory to another. Both directories must be on
  1541.     the same file server, but not necessarily on the same server volume.
  1542.     
  1543.     srcVRefNum    input:    Source volume specification.
  1544.     srcDirID    input:    Source directory ID.
  1545.     srcName        input:    Pointer to source directory name, or nil when
  1546.                         srcDirID specifies the directory.
  1547.     dstVRefNum    input:    Destination volume specification.
  1548.     dstDirID    input:    Destination directory ID.
  1549.     dstName        input:    Pointer to destination directory name, or nil when
  1550.                         dstDirID specifies the directory.
  1551.  
  1552.     __________
  1553.     
  1554.     See also:    FSpCopyDirectoryAccess
  1555. */
  1556.  
  1557. /*****************************************************************************/
  1558.  
  1559. pascal    OSErr    FSpCopyDirectoryAccess(const FSSpec *srcSpec,
  1560.                                        const FSSpec *dstSpec);
  1561. /*    ¶ Copy the AFP directory access privileges.
  1562.     The FSpCopyDirectoryAccess function copies the AFP directory access
  1563.     privileges from one directory to another. Both directories must be on
  1564.     the same file server, but not necessarily on the same server volume.
  1565.  
  1566.     srcSpec        input:    An FSSpec record specifying the source directory.
  1567.     dstSpec        input:    An FSSpec record specifying the destination directory.
  1568.  
  1569.     __________
  1570.     
  1571.     See also:    CopyDirectoryAccess
  1572. */
  1573.  
  1574. /*****************************************************************************/
  1575.  
  1576. pascal    OSErr    HMoveRenameCompat(short vRefNum,
  1577.                                   long srcDirID,
  1578.                                   ConstStr255Param srcName,
  1579.                                   long dstDirID,
  1580.                                   StringPtr dstpathName,
  1581.                                   StringPtr copyName);
  1582. /*    ¶ Move a file or directory and optionally rename it.
  1583.     The HMoveRenameCompat function moves a file or directory and optionally
  1584.     renames it.  The source and destination locations must be on the same
  1585.     volume. This routine works even if the volume doesn't support MoveRename.
  1586.     
  1587.     vRefNum        input:    Volume specification.
  1588.     srcDirID    input:    Source directory ID.
  1589.     srcName        input:    The source object name.
  1590.     dstDirID    input:    Destination directory ID.
  1591.     dstName        input:    Pointer to destination directory name, or
  1592.                         nil when dstDirID specifies a directory.
  1593.     copyName    input:    Points to the new name if the object is to be
  1594.                         renamed or nil if the object isn't to be renamed.
  1595.  
  1596.     __________
  1597.     
  1598.     See also:    FSpMoveRenameCompat
  1599. */
  1600.  
  1601. /*****************************************************************************/
  1602.  
  1603. pascal    OSErr    FSpMoveRenameCompat(const FSSpec *srcSpec,
  1604.                                     const FSSpec *dstSpec,
  1605.                                     StringPtr copyName);
  1606. /*    ¶ Move a file or directory and optionally rename it.
  1607.     The FSpMoveRenameCompat function moves a file or directory and optionally
  1608.     renames it.  The source and destination locations must be on the same
  1609.     volume. This routine works even if the volume doesn't support MoveRename.
  1610.     
  1611.     srcSpec        input:    An FSSpec record specifying the source object.
  1612.     dstSpec        input:    An FSSpec record specifying the destination
  1613.                         directory.
  1614.     copyName    input:    Points to the new name if the object is to be
  1615.                         renamed or nil if the object isn't to be renamed.
  1616.  
  1617.     __________
  1618.     
  1619.     See also:    HMoveRenameCompat
  1620. */
  1621.  
  1622. /*****************************************************************************/
  1623.  
  1624. pascal    void    BuildAFPVolMountInfo(short theFlags,
  1625.                                      char theNBPInterval,
  1626.                                      char theNBPCount,
  1627.                                      short theUAMType,
  1628.                                      Str31 theZoneName,
  1629.                                      Str31 theServerName,
  1630.                                      Str27 theVolName,
  1631.                                      Str31 theUserName,
  1632.                                      Str8 theUserPassWord,
  1633.                                      Str8 theVolPassWord,
  1634.                                      MyAFPVolMountInfoPtr theAFPInfo);
  1635. /*    ¶ Initialize the fields of an AFPVolMountInfo record.
  1636.     The BuildAFPVolMountInfo function initializes the fields of an
  1637.     AFPVolMountInfo record for use before using that record to call
  1638.     the VolumeMount function.
  1639.     
  1640.     theFlags        input:    The AFP mounting flags. 0 = normal mount;
  1641.                             set bit 0 to inhibit greeting messages.
  1642.     theNBPInterval    input:    The interval used for VolumeMount's
  1643.                             NBP Lookup call. 7 is a good choice.
  1644.     theNBPCount        input:    The retry count used for VolumeMount's
  1645.                             NBP Lookup call. 5 is a good choice.
  1646.     theUAMType        input:    The user authentication method to use.
  1647.     theZoneName        input:    The AppleTalk zone name of the server.
  1648.     theServerName    input:    The AFP server name.
  1649.     theVolName        input:    The AFP volume name.
  1650.     theUserName        input:    The user name (zero length Pascal string for
  1651.                             guest).
  1652.     theUserPassWord    input:    The user password (zero length Pascal string
  1653.                             if no user password)
  1654.     theVolPassWord    input:    The volume password (zero length Pascal string
  1655.                             if no volume password)
  1656.     theAFPInfo        input:    Pointer to AFPVolMountInfo record to
  1657.                             initialize.
  1658.  
  1659.     __________
  1660.     
  1661.     Also see:    GetVolMountInfoSize, GetVolMountInfo, VolumeMount,
  1662.                 RetrieveAFPVolMountInfo
  1663. */
  1664.  
  1665. /*****************************************************************************/
  1666.  
  1667. pascal    OSErr    RetrieveAFPVolMountInfo(AFPVolMountInfoPtr theAFPInfo,
  1668.                                         short *theFlags,
  1669.                                         short *theUAMType,
  1670.                                         StringPtr theZoneName,
  1671.                                         StringPtr theServerName,
  1672.                                         StringPtr theVolName,
  1673.                                         StringPtr theUserName);
  1674. /*    ¶ Retrieve the AFP mounting information from an AFPVolMountInfo record.
  1675.     The RetrieveAFPVolMountInfo function retrieves the AFP mounting
  1676.     information returned in an AFPVolMountInfo record by the
  1677.     GetVolMountInfo function.
  1678.     
  1679.     theAFPInfo        input:    Pointer to AFPVolMountInfo record that contains
  1680.                             the AFP mounting information.
  1681.     theFlags        output:    The AFP mounting flags. 0 = normal mount;
  1682.                             if bit 0 is set, greeting meesages were inhibited.
  1683.     theUAMType        output:    The user authentication method used.
  1684.     theZoneName        output:    The AppleTalk zone name of the server.
  1685.     theServerName    output:    The AFP server name.
  1686.     theVolName        output:    The AFP volume name.
  1687.     theUserName        output:    The user name (zero length Pascal string for
  1688.                             guest).
  1689.  
  1690.     __________
  1691.     
  1692.     Also see:    GetVolMountInfoSize, GetVolMountInfo, VolumeMount,
  1693.                 BuildAFPVolMountInfo
  1694. */
  1695.  
  1696. /*****************************************************************************/
  1697.  
  1698. pascal    OSErr    GetUGEntries(short objType,
  1699.                              UGEntryPtr entries,
  1700.                              long reqEntryCount,
  1701.                              long *actEntryCount,
  1702.                              long *objID);
  1703. /*    ¶ Retrieve a list of user or group entries from the local file server.
  1704.     The GetUGEntries functions retrieves a list of user or group entries
  1705.     fromthe local file server.
  1706.  
  1707.     objType            input:    The object type: -1 = group; 0 = user
  1708.     UGEntries        input:    Pointer to array of UGEntry records where the list
  1709.                             is returned.
  1710.     reqEntryCount    input:    The number of elements in the UGEntries array.
  1711.     actEntryCount    output:    The number of entries returned.
  1712.     objID            input:    The current index position. Set to 0 to start with
  1713.                             the first entry.
  1714.                     output:    The index position to get the next entry. Pass this
  1715.                             value the next time you call GetUGEntries to start
  1716.                             where you left off.
  1717.  
  1718.     __________
  1719.     
  1720.     Also see:    GetUGEntry
  1721. */
  1722.  
  1723. /*****************************************************************************/
  1724.  
  1725. #ifdef __cplusplus
  1726. }
  1727. #endif
  1728.  
  1729. #endif    /* __MOREFILESEXTRAS__ */
  1730.